DEVDOCS-6497 - Buyer Portal guides #1096
Conversation
Base information added to each file. Guides for Headless and Stencil filled in. Missing screenshots. Other files are placeholders for future content.
bc-terra
added
do not merge
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
…ted outdated B2B guide.
…n buyer portal docs
|
|
||
| Whether you use BigCommerce’s Stencil theme engine, the Catalyst storefront experience, or your own headless setup, these resources provide a step-by-step approach for forking, configuring, running, and deploying a custom Buyer Portal. The guides are designed for developers familiar with Node.js, React, and Yarn, and aim to get you started quickly with building and launching a tailored Buyer Portal experience. | ||
|
|
||
| ### Guides |
There was a problem hiding this comment.
The "Guides" and "Supported storefront models" links seem to be redundant. Can't we consolidate these?
| - **Hosted Buyer Portal:** Managed by BigCommerce, updated automatically. | ||
| - **Custom Buyer Portal:** Forked and customized by merchants/agencies for advanced branding, features, or integrations. | ||
|
|
||
| ### Architecture (high level) |
There was a problem hiding this comment.
My main piece of feedback would be to modify this section. Instead of the current bullet points, my recommendation would be to list the key parts of the tech stack:
- The B2B GraphQL API (link to our docs)
- React (https://react.dev/)
- React Router (https://reactrouter.com/)
- Material UI (https://mui.com/material-ui/)
- Redux (https://redux.js.org/)
|
|
||
| 1. Run the Catalyst CLI installer with the appropriate `gh-ref` for including B2B: | ||
| ``` | ||
| pnpm create @bigcommerce/catalyst@latest --gh-ref @bigcommerce/catalyst-b2b-makeswift@latest |
There was a problem hiding this comment.
Per the doc, the gh-ref will need to be integrations/b2b-makeswift right now. We can't use the latest tag until the Catalyst team has updated the integration.
| @@ -0,0 +1,169 @@ | |||
| # Catalyst \+ B2B Buyer Portal | |||
There was a problem hiding this comment.
I think this version of the setup guide was from the version in the doc that is currently labeled "BLOCKED" because the Catalyst team still hasn't merged in certain pull requests that support some of this content.
In the DEVDOCS ticket specific to the Catalyst setup guide, I noted that this version has been updated to account for the environment variables and code modification steps necessary until those PRs get merged:
https://docs.google.com/document/d/1RJOcKz9o-dlKbXQVd2PH__slzc4l6um9CtmC_BpSRnc/edit?tab=t.7h8bovx6u4y2
For this initial publish, we'll need to use that version of the guide. There are a few differences, including some additional steps.
Initial branch creation with relevant guide files.
Base information added to each file.
Guides for Headless and Stencil filled in. Missing screenshots. Other files are placeholders for future content.
DEVDOCS-6497
What changed?
Release notes draft
Anything else?
ping { @CNanninga @bigcommerce/dev-docs-team }